<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="utf-8">
  <meta http-equiv="X-UA-Compatible" content="IE=edge">
  <meta name="viewport" content="width=device-width, height=device-height, initial-scale=1, user-scalable=no">
  <meta name="description" content="API docs for the TRTCParams class from the trtc_cloud_def library, for the Dart programming language.">
  <title>TRTCParams class - trtc_cloud_def library - Dart API</title>


  
  <link rel="preconnect" href="https://fonts.gstatic.com">
  <link href="https://fonts.googleapis.com/css2?family=Roboto+Mono:ital,wght@0,300;0,400;0,500;0,700;1,400&display=swap" rel="stylesheet">
  <link href="https://fonts.googleapis.com/icon?family=Material+Icons" rel="stylesheet">
  
  <link rel="stylesheet" href="../static-assets/github.css?v1">
  <link rel="stylesheet" href="../static-assets/styles.css?v1">
  <link rel="icon" href="../static-assets/favicon.png?v1">

  
</head>


<body data-base-href="../"
      data-using-base-href="false">

<div id="overlay-under-drawer"></div>

<header id="title">
  <button id="sidenav-left-toggle" type="button">&nbsp;</button>
  <ol class="breadcrumbs gt-separated dark hidden-xs">
    <li><a href="../index.html">tencent_trtc_cloud</a></li>
    <li><a href="../trtc_cloud_def/trtc_cloud_def-library.html">trtc_cloud_def</a></li>
    <li class="self-crumb">TRTCParams class</li>
  </ol>
  <div class="self-name">TRTCParams</div>
  <form class="search navbar-right" role="search">
    <input type="text" id="search-box" autocomplete="off" disabled class="form-control typeahead" placeholder="Loading search...">
  </form>
</header>

<main>


  <div id="dartdoc-main-content" class="main-content">
      <div>
<h1><span class="kind-class">TRTCParams</span> class 
    <a href="https://dart.dev/null-safety" class="feature feature-null-safety" title="Supports the null safety language feature.">Null safety</a>
 
</h1></div>

    
<section class="desc markdown">
  <p>进房参数</p>
<p>作为 TRTC SDK 的进房参数，只有该参数填写正确，才能顺利进入 roomId 所指定的音视频房间</p>
</section>



    <section class="summary offset-anchor" id="constructors">
      <h2>Constructors</h2>

      <dl class="constructor-summary-list">
        <dt id="TRTCParams" class="callable">
          <span class="name"><a href="../trtc_cloud_def/TRTCParams/TRTCParams.html">TRTCParams</a></span><span class="signature">(<span class="parameter" id="-param-sdkAppId">{<span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/int-class.html">int</a></span> <span class="parameter-name">sdkAppId</span> = <span class="default-value">0</span>, </span><span class="parameter" id="-param-userId"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/String-class.html">String</a></span> <span class="parameter-name">userId</span> = <span class="default-value">&quot;&quot;</span>, </span><span class="parameter" id="-param-userSig"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/String-class.html">String</a></span> <span class="parameter-name">userSig</span> = <span class="default-value">&quot;&quot;</span>, </span><span class="parameter" id="-param-roomId"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/int-class.html">int</a></span> <span class="parameter-name">roomId</span> = <span class="default-value">0</span>, </span><span class="parameter" id="-param-strRoomId"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/String-class.html">String</a></span> <span class="parameter-name">strRoomId</span> = <span class="default-value">&quot;&quot;</span>, </span><span class="parameter" id="-param-role"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/int-class.html">int</a></span> <span class="parameter-name">role</span> = <span class="default-value">TRTCCloudDef.TRTCRoleAnchor</span>, </span><span class="parameter" id="-param-streamId"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/String-class.html">String</a></span> <span class="parameter-name">streamId</span> = <span class="default-value">&quot;&quot;</span>, </span><span class="parameter" id="-param-userDefineRecordId"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/String-class.html">String</a></span> <span class="parameter-name">userDefineRecordId</span> = <span class="default-value">&quot;&quot;</span>, </span><span class="parameter" id="-param-privateMapKey"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/String-class.html">String</a></span> <span class="parameter-name">privateMapKey</span> = <span class="default-value">&quot;&quot;</span>, </span><span class="parameter" id="-param-businessInfo"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/String-class.html">String</a></span> <span class="parameter-name">businessInfo</span> = <span class="default-value">&quot;&quot;</span>}</span>)</span>
        </dt>
        <dd>
           
        </dd>
      </dl>
    </section>

    <section class="summary offset-anchor" id="instance-properties">
      <h2>Properties</h2>

      <dl class="properties">
        <dt id="businessInfo" class="property">
  <span class="name"><a href="../trtc_cloud_def/TRTCParams/businessInfo.html">businessInfo</a></span>
  <span class="signature">&#8596; <a href="https://api.flutter.dev/flutter/dart-core/String-class.html">String</a></span> 

</dt>
<dd>
  业务数据 <code>非必填</code> 某些非常用的特殊需求才需要用到此字段。 <a href="../trtc_cloud_def/TRTCParams/businessInfo.html">[...]</a>
  <div class="features">read / write</div>

</dd>

        <dt id="hashCode" class="property inherited">
  <span class="name"><a href="https://api.flutter.dev/flutter/dart-core/Object/hashCode.html">hashCode</a></span>
  <span class="signature">&#8594; <a href="https://api.flutter.dev/flutter/dart-core/int-class.html">int</a></span> 

</dt>
<dd class="inherited">
  The hash code for this object. <a href="https://api.flutter.dev/flutter/dart-core/Object/hashCode.html">[...]</a>
  <div class="features">read-only, inherited</div>

</dd>

        <dt id="privateMapKey" class="property">
  <span class="name"><a href="../trtc_cloud_def/TRTCParams/privateMapKey.html">privateMapKey</a></span>
  <span class="signature">&#8596; <a href="https://api.flutter.dev/flutter/dart-core/String-class.html">String</a></span> 

</dt>
<dd>
  【字段含义】房间签名 <code>非必填</code>，当您希望某个房间只能让特定的 userId 进入时，需要使用 privateMapKey 进行权限保护。 <a href="../trtc_cloud_def/TRTCParams/privateMapKey.html">[...]</a>
  <div class="features">read / write</div>

</dd>

        <dt id="role" class="property">
  <span class="name"><a href="../trtc_cloud_def/TRTCParams/role.html">role</a></span>
  <span class="signature">&#8596; <a href="https://api.flutter.dev/flutter/dart-core/int-class.html">int</a></span> 

</dt>
<dd>
  【字段含义】直播场景下的角色，SDK 用这个参数确定用户是主播还是观众<code>直播场景下必填，通话场景下不填写</code>。 <a href="../trtc_cloud_def/TRTCParams/role.html">[...]</a>
  <div class="features">read / write</div>

</dd>

        <dt id="roomId" class="property">
  <span class="name"><a href="../trtc_cloud_def/TRTCParams/roomId.html">roomId</a></span>
  <span class="signature">&#8596; <a href="https://api.flutter.dev/flutter/dart-core/int-class.html">int</a></span> 

</dt>
<dd>
  【字段含义】房间号码 <code>必填</code> ，在同一个房间里的用户（userId）可以彼此看到对方并进行视频通话 <a href="../trtc_cloud_def/TRTCParams/roomId.html">[...]</a>
  <div class="features">read / write</div>

</dd>

        <dt id="runtimeType" class="property inherited">
  <span class="name"><a href="https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html">runtimeType</a></span>
  <span class="signature">&#8594; <a href="https://api.flutter.dev/flutter/dart-core/Type-class.html">Type</a></span> 

</dt>
<dd class="inherited">
  A representation of the runtime type of the object. 
  <div class="features">read-only, inherited</div>

</dd>

        <dt id="sdkAppId" class="property">
  <span class="name"><a href="../trtc_cloud_def/TRTCParams/sdkAppId.html">sdkAppId</a></span>
  <span class="signature">&#8596; <a href="https://api.flutter.dev/flutter/dart-core/int-class.html">int</a></span> 

</dt>
<dd>
  【字段含义】应用标识 <code>必填</code>，腾讯视频云基于 sdkAppId 进行计费统计。 <a href="../trtc_cloud_def/TRTCParams/sdkAppId.html">[...]</a>
  <div class="features">read / write</div>

</dd>

        <dt id="streamId" class="property">
  <span class="name"><a href="../trtc_cloud_def/TRTCParams/streamId.html">streamId</a></span>
  <span class="signature">&#8596; <a href="https://api.flutter.dev/flutter/dart-core/String-class.html">String</a></span> 

</dt>
<dd>
  【字段含义】绑定腾讯云直播 CDN 流 ID<code>非必填</code>，设置之后，您就可以在腾讯云直播 CDN 上通过标准直播方案（FLV或HLS）播放该用户的音视频流。 <a href="../trtc_cloud_def/TRTCParams/streamId.html">[...]</a>
  <div class="features">read / write</div>

</dd>

        <dt id="strRoomId" class="property">
  <span class="name"><a href="../trtc_cloud_def/TRTCParams/strRoomId.html">strRoomId</a></span>
  <span class="signature">&#8596; <a href="https://api.flutter.dev/flutter/dart-core/String-class.html">String</a></span> 

</dt>
<dd>
  字符串房间号码，在同一个房间内的用户（userId）可以看到彼此并进行视频通话。 <a href="../trtc_cloud_def/TRTCParams/strRoomId.html">[...]</a>
  <div class="features">read / write</div>

</dd>

        <dt id="userDefineRecordId" class="property">
  <span class="name"><a href="../trtc_cloud_def/TRTCParams/userDefineRecordId.html">userDefineRecordId</a></span>
  <span class="signature">&#8596; <a href="https://api.flutter.dev/flutter/dart-core/String-class.html">String</a></span> 

</dt>
<dd>
  [字段含义】云端录制开关，用于指定是否要在云端将该用户的音视频流录制成指定格式的文件。 <a href="../trtc_cloud_def/TRTCParams/userDefineRecordId.html">[...]</a>
  <div class="features">read / write</div>

</dd>

        <dt id="userId" class="property">
  <span class="name"><a href="../trtc_cloud_def/TRTCParams/userId.html">userId</a></span>
  <span class="signature">&#8596; <a href="https://api.flutter.dev/flutter/dart-core/String-class.html">String</a></span> 

</dt>
<dd>
  【字段含义】用户标识 <code>必填</code>，当前用户的 userId，相当于用户名。 <a href="../trtc_cloud_def/TRTCParams/userId.html">[...]</a>
  <div class="features">read / write</div>

</dd>

        <dt id="userSig" class="property">
  <span class="name"><a href="../trtc_cloud_def/TRTCParams/userSig.html">userSig</a></span>
  <span class="signature">&#8596; <a href="https://api.flutter.dev/flutter/dart-core/String-class.html">String</a></span> 

</dt>
<dd>
  【字段含义】用户签名 <code>必填</code>，当前 userId 对应的验证签名，相当于使用云服务的登录密码。 <a href="../trtc_cloud_def/TRTCParams/userSig.html">[...]</a>
  <div class="features">read / write</div>

</dd>

      </dl>
    </section>

    <section class="summary offset-anchor" id="instance-methods">
      <h2>Methods</h2>
      <dl class="callables">
        <dt id="noSuchMethod" class="callable inherited">
  <span class="name"><a href="https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html">noSuchMethod</a></span><span class="signature">(<wbr><span class="parameter" id="noSuchMethod-param-invocation"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/Invocation-class.html">Invocation</a></span> <span class="parameter-name">invocation</span></span>)
    <span class="returntype parameter">&#8594; dynamic</span>
  </span>
  

</dt>
<dd class="inherited">
  Invoked when a non-existent method or property is accessed. <a href="https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html">[...]</a>
  <div class="features">inherited</div>

</dd>

        <dt id="toJson" class="callable">
  <span class="name"><a href="../trtc_cloud_def/TRTCParams/toJson.html">toJson</a></span><span class="signature">(<wbr>)
    <span class="returntype parameter">&#8594; <a href="https://api.flutter.dev/flutter/dart-core/Map-class.html">Map</a><span class="signature">&lt;<wbr><span class="type-parameter"><a href="https://api.flutter.dev/flutter/dart-core/String-class.html">String</a></span>, <span class="type-parameter">dynamic</span>&gt;</span></span>
  </span>
  

</dt>
<dd>
   
  

</dd>

        <dt id="toString" class="callable inherited">
  <span class="name"><a href="https://api.flutter.dev/flutter/dart-core/Object/toString.html">toString</a></span><span class="signature">(<wbr>)
    <span class="returntype parameter">&#8594; <a href="https://api.flutter.dev/flutter/dart-core/String-class.html">String</a></span>
  </span>
  

</dt>
<dd class="inherited">
  A string representation of this object. <a href="https://api.flutter.dev/flutter/dart-core/Object/toString.html">[...]</a>
  <div class="features">inherited</div>

</dd>

      </dl>
    </section>

    <section class="summary offset-anchor inherited" id="operators">
      <h2>Operators</h2>
      <dl class="callables">
        <dt id="operator ==" class="callable inherited">
  <span class="name"><a href="https://api.flutter.dev/flutter/dart-core/Object/operator_equals.html">operator ==</a></span><span class="signature">(<wbr><span class="parameter" id="==-param-other"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/Object-class.html">Object</a></span> <span class="parameter-name">other</span></span>)
    <span class="returntype parameter">&#8594; <a href="https://api.flutter.dev/flutter/dart-core/bool-class.html">bool</a></span>
  </span>
  

</dt>
<dd class="inherited">
  The equality operator. <a href="https://api.flutter.dev/flutter/dart-core/Object/operator_equals.html">[...]</a>
  <div class="features">inherited</div>

</dd>

      </dl>
    </section>




  </div> <!-- /.main-content -->

  <div id="dartdoc-sidebar-left" class="sidebar sidebar-offcanvas-left">
    <header id="header-search-sidebar" class="hidden-l">
  <form class="search-sidebar" role="search">
    <input type="text" id="search-sidebar" autocomplete="off" disabled class="form-control typeahead" placeholder="Loading search...">
  </form>
</header>

<ol class="breadcrumbs gt-separated dark hidden-l" id="sidebar-nav">
  <li><a href="../index.html">tencent_trtc_cloud</a></li>
  <li><a href="../trtc_cloud_def/trtc_cloud_def-library.html">trtc_cloud_def</a></li>
  <li class="self-crumb">TRTCParams class</li>
</ol>


    <h5>trtc_cloud_def library</h5>
    <ol>
  <li class="section-title"><a href="../trtc_cloud_def/trtc_cloud_def-library.html#classes">Classes</a></li>
  <li><a href="../trtc_cloud_def/AudioMusicParam-class.html">AudioMusicParam</a></li>
  <li><a href="../trtc_cloud_def/CustomLocalRender-class.html">CustomLocalRender</a></li>
  <li><a href="../trtc_cloud_def/CustomRemoteRender-class.html">CustomRemoteRender</a></li>
  <li><a href="../trtc_cloud_def/TRTCAudioRecordingParams-class.html">TRTCAudioRecordingParams</a></li>
  <li><a href="../trtc_cloud_def/TRTCCloudDef-class.html">TRTCCloudDef</a></li>
  <li><a href="../trtc_cloud_def/TRTCLocalRecordingParams-class.html">TRTCLocalRecordingParams</a></li>
  <li><a href="../trtc_cloud_def/TRTCMixUser-class.html">TRTCMixUser</a></li>
  <li><a href="../trtc_cloud_def/TRTCNetworkQosParam-class.html">TRTCNetworkQosParam</a></li>
  <li><a href="../trtc_cloud_def/TRTCParams-class.html">TRTCParams</a></li>
  <li><a href="../trtc_cloud_def/TRTCPublishCDNParam-class.html">TRTCPublishCDNParam</a></li>
  <li><a href="../trtc_cloud_def/TRTCRenderParams-class.html">TRTCRenderParams</a></li>
  <li><a href="../trtc_cloud_def/TRTCSwitchRoomConfig-class.html">TRTCSwitchRoomConfig</a></li>
  <li><a href="../trtc_cloud_def/TRTCTranscodingConfig-class.html">TRTCTranscodingConfig</a></li>
  <li><a href="../trtc_cloud_def/TRTCVideoEncParam-class.html">TRTCVideoEncParam</a></li>
  <li><a href="../trtc_cloud_def/TXVoiceChangerType-class.html">TXVoiceChangerType</a></li>
  <li><a href="../trtc_cloud_def/TXVoiceReverbType-class.html">TXVoiceReverbType</a></li>








</ol>

  </div>

  <div id="dartdoc-sidebar-right" class="sidebar sidebar-offcanvas-right">
    <ol>

    <li class="section-title"><a href="../trtc_cloud_def/TRTCParams-class.html#constructors">Constructors</a></li>
    <li><a href="../trtc_cloud_def/TRTCParams/TRTCParams.html">TRTCParams</a></li>


    <li class="section-title">
      <a href="../trtc_cloud_def/TRTCParams-class.html#instance-properties">Properties</a>
    </li>
    <li><a href="../trtc_cloud_def/TRTCParams/businessInfo.html">businessInfo</a></li>
    <li class="inherited"><a href="https://api.flutter.dev/flutter/dart-core/Object/hashCode.html">hashCode</a></li>
    <li><a href="../trtc_cloud_def/TRTCParams/privateMapKey.html">privateMapKey</a></li>
    <li><a href="../trtc_cloud_def/TRTCParams/role.html">role</a></li>
    <li><a href="../trtc_cloud_def/TRTCParams/roomId.html">roomId</a></li>
    <li class="inherited"><a href="https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html">runtimeType</a></li>
    <li><a href="../trtc_cloud_def/TRTCParams/sdkAppId.html">sdkAppId</a></li>
    <li><a href="../trtc_cloud_def/TRTCParams/streamId.html">streamId</a></li>
    <li><a href="../trtc_cloud_def/TRTCParams/strRoomId.html">strRoomId</a></li>
    <li><a href="../trtc_cloud_def/TRTCParams/userDefineRecordId.html">userDefineRecordId</a></li>
    <li><a href="../trtc_cloud_def/TRTCParams/userId.html">userId</a></li>
    <li><a href="../trtc_cloud_def/TRTCParams/userSig.html">userSig</a></li>

    <li class="section-title"><a href="../trtc_cloud_def/TRTCParams-class.html#instance-methods">Methods</a></li>
    <li class="inherited"><a href="https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html">noSuchMethod</a></li>
    <li><a href="../trtc_cloud_def/TRTCParams/toJson.html">toJson</a></li>
    <li class="inherited"><a href="https://api.flutter.dev/flutter/dart-core/Object/toString.html">toString</a></li>

    <li class="section-title inherited"><a href="../trtc_cloud_def/TRTCParams-class.html#operators">Operators</a></li>
    <li class="inherited"><a href="https://api.flutter.dev/flutter/dart-core/Object/operator_equals.html">operator ==</a></li>




</ol>

  </div><!--/.sidebar-offcanvas-->

</main>

<footer>
  <span class="no-break">
    tencent_trtc_cloud
      1.2.4
  </span>

  
</footer>



<script src="../static-assets/highlight.pack.js?v1"></script>
<script src="../static-assets/script.js?v1"></script>



</body>

</html>

